modify withRunbookURL to allow internal annotation #1139

tristanburgess · 2024-02-05T14:02:36Z

see https://github.com/grafana/deployment_tools/pull/118284

this PR allows a user of the withRunbookURL function to indicate that the internal_runbook_url annotation should be used instead of the runbook_url annotation.

CLAassistant · 2024-02-05T14:02:47Z

All committers have signed the CLA.

Duologic · 2024-02-05T14:24:35Z

mixin-utils/utils.libsonnet

@@ -117,12 +117,12 @@ local g = import 'grafana-builder/grafana.libsonnet';
  // withRunbookURL - Add/Override the runbook_url annotations for all alerts inside a list of rule groups.
  // - url_format: an URL format for the runbook, the alert name will be substituted in the URL.
  // - groups: the list of rule groups containing alerts.
-  withRunbookURL(url_format, groups)::
+  withRunbookURL(url_format, groups, internal=false)::


Adding conditional like this is a bit of anti pattern that leads to overloading a function signature to satisfy every user.

I'd suggest giving the original default like this, it'll allow the same override but needs less maintenance if someone follows a slightly alternative annotation approach.

Suggested change

withRunbookURL(url_format, groups, internal=false)::

withRunbookURL(url_format, groups, annotation_key='runbook_url')::

Perhaps also add a line of documentation above this function to explain it.

updated and tested

tk diff ksonnet/environments/ruler-exporter/main.jsonnet --name environments/ruler-exporter/dev-us-central-0 ... --- - alert: UnhealthyComponents + alert: "UnhealthyComponents" annotations: - message: Unhealthy Flow components detected. + custom_runbook_annotation_key: "https://github.com/grafana/cloud-onboarding/blob/main/runbooks/HostedExporters-Agent.md#AgentUnhealthyComponents" + message: "Unhealthy Flow components detected." expr: "sum(agent_component_controller_running_components{health_type!=\"healthy\"}) > 0" - for: 15m + for: "15m"

Updates grafana-builder and mixin-utils to latest version in master branch. This will be helpful in creating Grafana panels that use the timeseriesPanel instead of the deprecated panel. grafana-builder changes: - grafana-builder: add support for native/classic stat panel query (grafana/jsonnet-libs#1285) - More native histograms related utils and renaming (grafana/jsonnet-libs#1270) - Support recording and switching between naive and classic latency histograms (grafana/jsonnet-libs#1150) - Basic native histogram utilities (grafana/jsonnet-libs#1164) - grafana-builder: rename template variable "Data Source" to "Data source" (grafana/jsonnet-libs#1111) - Mixins: draw graphs at full resolution (grafana/jsonnet-libs#825) - Allow dashboards to show gRPC codes as labels (grafana/jsonnet-libs#1098) - Allow configuring sort order for variables (grafana/jsonnet-libs#1014) - remove unused/wrong step param (grafana/jsonnet-libs#999) - Show cancelled requests in grey on QPS dashboards. (grafana/jsonnet-libs#988) - Show cancelled requests in yellow on QPS dashboards. (grafana/jsonnet-libs#986) - Add timeseriesPanel (grafana/jsonnet-libs#824) - Allow including "All" for single template var - Allow datasource's regex to be configured - grafana-builder: make allValue configurable (grafana/jsonnet-libs#703) - grafana_builder: add dashboard link func (grafana/jsonnet-libs#683) - Add 'Data Source' label for the default datasource template variable. (grafana/jsonnet-libs#672) - enable toolip by default (grafana/jsonnet-libs#665) mixin-utils changes: - grafana-builder: add support for native/classic stat panel query (grafana/jsonnet-libs#1285) - More native histograms related utils and renaming (grafana/jsonnet-libs#1270) - nativeClassicSumBy: format list of labels nicer (grafana/jsonnet-libs#1204) - Support recording and switching between naive and classic latency histograms (grafana/jsonnet-libs#1150) - chore: fix hardcoded range interval (grafana/jsonnet-libs#1190) - Basic native histogram utilities (grafana/jsonnet-libs#1164) - utils: allow defining native histogram recording rule (grafana/jsonnet-libs#1156) - modify withRunbookURL to allow internal annotation (grafana/jsonnet-libs#1139) - mixin-utils: drop unsupported step target parameter (grafana/jsonnet-libs#1128) - Mixins: draw graphs at full resolution (grafana/jsonnet-libs#825) - Align with style conventions (grafana/jsonnet-libs#1038) - Add a function to remove an alert rule (grafana/jsonnet-libs#812) - mixin-utils: Parameterize interval for histogramRules (grafana/jsonnet-libs#806) - refactor(grafana/jsonnet-libsprometheus): shard mixins over multiple configmaps (grafana/jsonnet-libs#497) - Not all Prometheus rules are alerts. (grafana/jsonnet-libs#490)

Updates grafana-builder and mixin-utils to latest version in master branch. This will be helpful in creating Grafana panels that use the timeseriesPanel instead of the deprecated panel. grafana-builder changes: - grafana-builder: add support for native/classic stat panel query (grafana/jsonnet-libs#1285) - More native histograms related utils and renaming (grafana/jsonnet-libs#1270) - Support recording and switching between naive and classic latency histograms (grafana/jsonnet-libs#1150) - Basic native histogram utilities (grafana/jsonnet-libs#1164) - grafana-builder: rename template variable "Data Source" to "Data source" (grafana/jsonnet-libs#1111) - Mixins: draw graphs at full resolution (grafana/jsonnet-libs#825) - Allow dashboards to show gRPC codes as labels (grafana/jsonnet-libs#1098) - Allow configuring sort order for variables (grafana/jsonnet-libs#1014) - remove unused/wrong step param (grafana/jsonnet-libs#999) - Show cancelled requests in grey on QPS dashboards. (grafana/jsonnet-libs#988) - Show cancelled requests in yellow on QPS dashboards. (grafana/jsonnet-libs#986) - Add timeseriesPanel (grafana/jsonnet-libs#824) - Allow including "All" for single template var - Allow datasource's regex to be configured - grafana-builder: make allValue configurable (grafana/jsonnet-libs#703) - grafana_builder: add dashboard link func (grafana/jsonnet-libs#683) - Add 'Data Source' label for the default datasource template variable. (grafana/jsonnet-libs#672) - enable toolip by default (grafana/jsonnet-libs#665) mixin-utils changes: - grafana-builder: add support for native/classic stat panel query (grafana/jsonnet-libs#1285) - More native histograms related utils and renaming (grafana/jsonnet-libs#1270) - nativeClassicSumBy: format list of labels nicer (grafana/jsonnet-libs#1204) - Support recording and switching between naive and classic latency histograms (grafana/jsonnet-libs#1150) - chore: fix hardcoded range interval (grafana/jsonnet-libs#1190) - Basic native histogram utilities (grafana/jsonnet-libs#1164) - utils: allow defining native histogram recording rule (grafana/jsonnet-libs#1156) - modify withRunbookURL to allow internal annotation (grafana/jsonnet-libs#1139) - mixin-utils: drop unsupported step target parameter (grafana/jsonnet-libs#1128) - Mixins: draw graphs at full resolution (grafana/jsonnet-libs#825) - Align with style conventions (grafana/jsonnet-libs#1038) - Add a function to remove an alert rule (grafana/jsonnet-libs#812) - mixin-utils: Parameterize interval for histogramRules (grafana/jsonnet-libs#806) - refactor(grafana/jsonnet-libsprometheus): shard mixins over multiple configmaps (grafana/jsonnet-libs#497) - Not all Prometheus rules are alerts. (grafana/jsonnet-libs#490) Signed-off-by: Charlie Le <[email protected]>

* Update jsonnet-libs to Fri Jul 19 12:51:49 2024 Updates grafana-builder and mixin-utils to latest version in master branch. This will be helpful in creating Grafana panels that use the timeseriesPanel instead of the deprecated panel. grafana-builder changes: - grafana-builder: add support for native/classic stat panel query (grafana/jsonnet-libs#1285) - More native histograms related utils and renaming (grafana/jsonnet-libs#1270) - Support recording and switching between naive and classic latency histograms (grafana/jsonnet-libs#1150) - Basic native histogram utilities (grafana/jsonnet-libs#1164) - grafana-builder: rename template variable "Data Source" to "Data source" (grafana/jsonnet-libs#1111) - Mixins: draw graphs at full resolution (grafana/jsonnet-libs#825) - Allow dashboards to show gRPC codes as labels (grafana/jsonnet-libs#1098) - Allow configuring sort order for variables (grafana/jsonnet-libs#1014) - remove unused/wrong step param (grafana/jsonnet-libs#999) - Show cancelled requests in grey on QPS dashboards. (grafana/jsonnet-libs#988) - Show cancelled requests in yellow on QPS dashboards. (grafana/jsonnet-libs#986) - Add timeseriesPanel (grafana/jsonnet-libs#824) - Allow including "All" for single template var - Allow datasource's regex to be configured - grafana-builder: make allValue configurable (grafana/jsonnet-libs#703) - grafana_builder: add dashboard link func (grafana/jsonnet-libs#683) - Add 'Data Source' label for the default datasource template variable. (grafana/jsonnet-libs#672) - enable toolip by default (grafana/jsonnet-libs#665) mixin-utils changes: - grafana-builder: add support for native/classic stat panel query (grafana/jsonnet-libs#1285) - More native histograms related utils and renaming (grafana/jsonnet-libs#1270) - nativeClassicSumBy: format list of labels nicer (grafana/jsonnet-libs#1204) - Support recording and switching between naive and classic latency histograms (grafana/jsonnet-libs#1150) - chore: fix hardcoded range interval (grafana/jsonnet-libs#1190) - Basic native histogram utilities (grafana/jsonnet-libs#1164) - utils: allow defining native histogram recording rule (grafana/jsonnet-libs#1156) - modify withRunbookURL to allow internal annotation (grafana/jsonnet-libs#1139) - mixin-utils: drop unsupported step target parameter (grafana/jsonnet-libs#1128) - Mixins: draw graphs at full resolution (grafana/jsonnet-libs#825) - Align with style conventions (grafana/jsonnet-libs#1038) - Add a function to remove an alert rule (grafana/jsonnet-libs#812) - mixin-utils: Parameterize interval for histogramRules (grafana/jsonnet-libs#806) - refactor(grafana/jsonnet-libsprometheus): shard mixins over multiple configmaps (grafana/jsonnet-libs#497) - Not all Prometheus rules are alerts. (grafana/jsonnet-libs#490) Signed-off-by: Charlie Le <[email protected]> * Use `timeseriesPanel` instead of `panel` when creating panels Fixes: #44 Depends on: #57 Signed-off-by: Charlie Le <[email protected]> * Add units to timeseries panel The yaxes field doesn't seem to do anything in the timeseries panel and was replaced with the units field instead. So I defaulted the units to be short and allowed it to be set for the panel. Signed-off-by: Charlie Le <[email protected]> * Update CHANGELOG.md --------- Signed-off-by: Charlie Le <[email protected]> Co-authored-by: Friedrich Gonzalez <[email protected]>

modify withRunbookURL to allow internal annotation

b7ff233

tristanburgess requested review from Duologic, kgeckhart and andriikushch February 5, 2024 14:03

lint fixes

7c38a8c

tristanburgess requested a review from tpaschalis February 5, 2024 14:08

Duologic requested changes Feb 5, 2024

View reviewed changes

tristanburgess requested a review from Duologic February 5, 2024 15:38

PR feedback

7487101

tristanburgess force-pushed the tristanburgess/add-runbookurl-internal branch from 9f11488 to 7487101 Compare February 5, 2024 15:39

Duologic approved these changes Feb 5, 2024

View reviewed changes

tristanburgess merged commit cc9a6a1 into master Feb 5, 2024
2 checks passed

tristanburgess deleted the tristanburgess/add-runbookurl-internal branch February 5, 2024 22:04

CharlieTLe mentioned this pull request Jul 21, 2024

Update jsonnet-libs to Fri Jul 19 12:51:49 2024 cortexproject/cortex-jsonnet#57

Merged

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

modify withRunbookURL to allow internal annotation #1139

modify withRunbookURL to allow internal annotation #1139

tristanburgess commented Feb 5, 2024

CLAassistant commented Feb 5, 2024 •

edited

Loading

Duologic Feb 5, 2024

tristanburgess Feb 5, 2024

	withRunbookURL(url_format, groups, internal=false)::
	withRunbookURL(url_format, groups, annotation_key='runbook_url')::

modify withRunbookURL to allow internal annotation #1139

modify withRunbookURL to allow internal annotation #1139

Conversation

tristanburgess commented Feb 5, 2024

CLAassistant commented Feb 5, 2024 • edited Loading

Duologic Feb 5, 2024

Choose a reason for hiding this comment

tristanburgess Feb 5, 2024

Choose a reason for hiding this comment

CLAassistant commented Feb 5, 2024 •

edited

Loading